PayPay

PayPay決済 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却
Request header
Content-Type: application/json;charset=UTF-8
Method
POST
Response header
Content-Type: application/json;charset=UTF-8
Status Code
  • 200：正常時
  • 400：入力パラメータエラー、加盟店設定エラー
  • 500：システムエラー
  • 502：決済エラー
　　　　　　　
    ※以下のエラーコードはhttp200で返却される可能性がございます。
    　 ・E90010001
    　 ・E92000001
    　 ・E92000002
    　 ・E91099996
    　 ・E91099997

EntryTranPaypay 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値

JobCd jobCd 必須 半角英字7桁
処理区分

AUTH：仮売上
CAPTURE：即時売上

Amount amount 必須 半角数字7桁
利用金額
Tax tax 半角数字7桁
税送料

URL
/payment/EntryTranPaypay.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "orderID": "ORDER0000001",
    "jobCd": "CAPTURE",
    "amount": "1000"
}
URL
/payment/EntryTranPaypay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=CAPTURE&Amount=1000
レスポンス
正常
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranPaypay 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。

OrderID orderID 必須 半角英数記号27桁
オーダーID

【取引登録】で指定した値を設定します。

ClientField1 clientField1 全半角100バイト
加盟店自由項目1
ClientField2 clientField2 全半角100バイト
加盟店自由項目2
ClientField3 clientField3 全半角100バイト
加盟店自由項目3
RetURL retURL 必須 半角英数記号256桁
決済結果戻しURL

加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。
PayPayアプリ上でお客様が決済処理を実行した場合に、指定されたURLにブラウザのリダイレクト経由で結果が送信されます。

PaymentTermSec paymentTermSec 半角数字5桁
支払開始期限秒

お客様が【決済実行】から【支払手続き開始IF】を呼び出すまでの期限です。
最大86,400秒（1日）
呼出パラメータが空の場合、120秒で処理されます。

TransitionType transitionType 半角数字1桁
PayPayアプリ遷移種別

1 ：アプリから遷移(WebLink)
2 ：アプリから遷移(DeepLink)
「1」を指定した場合は、ユーザーのスマホにPayPayアプリがインストールされていない場合でもWebベースでの決済が可能です。
「2」を指定した場合は、ユーザーのスマホにPayPayアプリがインストールされてない場合、決済が完了できません。
ただし、ご利用のデバイスによっては決済が完了する場合もあります。

URL
/payment/ExecTranPaypay.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "retURL": "https://example.com/receive"
}
URL
/payment/ExecTranPaypay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive
レスポンス
正常
AccessID accessID 必須 半角英数32桁 固定
取引ID
Token token 必須 半角英数64桁 固定
トークン

取引IDのハッシュ値を返却します。

StartURL startURL 必須 半角英数記号256桁
支払手続き開始IFのURL

支払手続き開始IFのURLを返却します。

StartLimitDate startLimitDate 必須 半角数字14桁 固定
支払開始期限日時

支払手続き開始IFの呼び出し期限を返却します。
yyyyMMddHHmmss書式

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
    "accessID": "84636abd0bb03500ffce1e1a78deb1b2",
    "token": "107c44550ac7f47cbc6dbef22c4c27fd",
    "startURL": "https://x01.mul-pay.jp/payment/PaypayStart.idPass",
    "startLimitDate": "20220722112429"
}
レスポンスパラメータ：正常系
AccessID=84636abd0bb03500ffce1e1a78deb1b2&Token=107c44550ac7f47cbc6dbef22c4c27fd&StartURL=https://x01.mul-pay.jp/payment/PaypayStart.idPass&StartLimitDate=20220722112429
レスポンスパラメータ：異常系
[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

PaypayStart 決済開始

PayPayにおいて、お客様をPayPayアプリへ遷移させる必要があります。 当サービスのリダイレクト機能を利用して、お客様を当サービスの支払手続き開始IFに誘導してください。 ※取引が特定できない場合、すでに支払いを済ませている場合等は、エラー画面を表示します。
※idPass版にのみ対応しています。json版には対応しておりません。

リクエスト
AccessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

Token 必須 半角英数64桁 固定
トークン

【決済実行】で発行された値を設定します。

URL
/payment/PaypayStart.idPass
リダイレクトページサンプル
<html>
      <head>
      <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
      </head>
      <body OnLoad='OnLoadEvent();'>
      <form name="PaypayStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
        <noscript>
          <br>
          <br>
          <div style="text-align:center">
            <h2>PayPayの決済画面へ遷移します。</h2>
            <input type="submit" value="続行">
          </div>
        </noscript>
        <input type="hidden" name="AccessID" value="{AccessID}">
        <input type="hidden" name="Token" value="{Token}">
      </form>
      <script>
    <!--
    function OnLoadEvent() {
    document.PaypayStartCall.submit();
    }
    //-->
      </script>
      </body>
    </html>

リダイレクト後、お客様はPayPayログイン画面へ遷移します。

決済結果受信

当サービスは、お客様が支払操作を完了または中止した際に、決済実行時に指定された決済結果戻しURLに結果を通知します。
この決済結果は、お客様に表示しているPayPayの購入完了画面からブラウザ経由で連携されるため、お客様の操作方法によっては支払操作が完了したにもかかわらず、加盟店様に通知されないことがあります。
その際はショップ管理画面または結果通知にてご確認ください。
また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。

レスポンス
正常
ShopID 必須 半角英数13桁
ショップID
OrderID 必須 半角英数記号27桁
オーダーID
Status 必須
現状態

AUTH：仮売上
CAPTURE：即時売上
PAYFAIL：決済失敗
EXPIRED：期限切れ

TranDate 必須 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

PayPayTrackingID 半角英数14桁
PayPayトラッキングID

決済成功時のみ値を設定します。
PayPayOrderID 半角英数20桁
PayPay決済番号

決済成功時のみ値を設定します。
CheckString 必須 半角英数64桁
改ざんチェック文字列

以下の情報を連結し、SHA256ハッシュした値を返却します。
・ショップID
・オーダーID
・現状態
・処理日時
・PayPayトラッキングID
・ショップパスワード

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード

PaypaySales 実売上

仮売上の決済に対して実売上を行います。仮売上の決済の取引ID・取引パスワードを指定すると、売上の確定処理が可能です。
※事業者側でエラーになる可能性がありますので、仮売上から数秒空けて実行してください。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。

OrderID orderID 必須 半角英数記号27桁
オーダーID
Amount amount 必須 半角数字7桁
利用金額

税送料を指定した場合は、合計利用金額が売上確定となります。


仮売上時の合計利用金額に満たない金額を指定した場合、差額はキャンセルされます。
（一部実売上の例）
　仮売上時の利用金額 = 1000円
　指定する利用金額 ＝ 800円
上記の条件で実売上を行った結果
　売上金額 = 800円
　キャンセル金額 = 200円

Tax tax 半角数字7桁
税送料

URL
/payment/PaypaySales.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "amount": "1000"
}
URL
/payment/PaypaySales.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000
レスポンス
正常
OrderID orderID 必須 半角英数記号27桁
オーダーID
Status status 必須
現状態

SALES：実売上
REQSALES：実売上受付

Amount amount 必須 半角数字7桁
利用金額

Tax tax 必須 半角数字7桁
税送料

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
    "orderID": "ORDER0000001",
    "status": "SALES",
    "amount": "100",
    "tax": "0"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=SALES&Amount=100&Tax=0
レスポンスパラメータ：異常系
[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

PaypayCancelReturn キャンセル

取引の取引ID・取引パスワードを指定すると、以前に実施した決済内容をキャンセルすることが可能です。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。

OrderID orderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

CancelAmount cancelAmount 必須 半角数字7桁
利用金額

仮売上、実売上、即時売上時の合計利用金額と一致する金額を設定するとキャンセルします。

（一部キャンセルを行いたい場合）
キャンセルしたい金額を設定します。
設定した金額がお客様に返金され、差額は実売上、即時売上の状態のままとなります。
例）
　実売上時の利用金額 = 1000円
　設定した利用金額 ＝ 200円
上記の条件でキャンセルを行った結果
　売上金額 = 800円
　キャンセル金額 = 200円

CancelTax cancelTax 半角数字7桁
税送料

URL
/payment/PaypayCancelReturn.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "cancelAmount": "1000"
}
URL
/payment/PaypayCancelReturn.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=1000
レスポンス
正常
OrderID orderID 必須 半角英数記号27桁
オーダーID
Status status 必須
現状態

　CANCEL：キャンセル
　RETURN：返金
　SALES：実売上（※）
　CAPTURE：即時売上（※）
※一部キャンセルの場合に返却されます。

CancelAmount cancelAmount 必須 半角数字7桁
キャンセル利用金額
CancelTax cancelTax 必須 半角数字7桁
キャンセル税送料

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
    "orderID": "ORDER0000001",
    "status": "RETURN",
    "cancelAmount": "100",
    "cancelTax": "0"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=RETURN&CancelAmount=100&CancelTax=0
レスポンスパラメータ：異常系
[
    {
"errCode":"E01",
"errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。
※idPass版にのみ対応しています。json版には対応しておりません。

リクエスト
ShopID 必須 半角英数13桁
ショップID
ShopPass 必須 半角英数64桁
ショップパスワード
OrderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

PayType 必須 半角数字2桁
決済方法

45：PayPay

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=45
レスポンス
正常
Status 必須
現状態

UNPROCESSED：未決済
REQSUCCESS：要求成功
AUTHPROCESS：認証処理中
AUTH：仮売上
SALES：実売上
REQSALES：実売上受付
CAPTURE：即時売上
CANCEL：キャンセル
RETURN：返金
PAYFAIL：決済失敗
EXPIRED：期限切れ

ProcessDate 必須 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

JobCd 必須
処理区分

AUTH：仮売上
SALES：実売上
CAPTURE：即時売上
CANCEL：キャンセル
RETURN：返金
EXPIRE：期限切れ

AccessID 必須 半角英数32桁 固定
取引ID
AccessPass 必須 半角英数32桁 固定
取引パスワード
Amount 必須 半角数字7桁
利用金額
Tax 必須 半角数字7桁
税送料

ClientField1 必須 全半角100バイト
加盟店自由項目1

ClientField2 必須 全半角100バイト
加盟店自由項目2

ClientField3 必須 全半角100バイト
加盟店自由項目3

PayType 必須 半角数字2桁
決済方法

45：PayPay

PayPayCancelAmount 必須 半角数字7桁
キャンセル金額
PayPayCancelTax 必須 半角数字7桁
キャンセル税送料金額
PayPayTrackingID 半角英数14桁
PayPayトラッキングID
PayPayAcceptCode 半角英数14桁
PayPay承諾番号
PayPayOrderID 半角英数20桁
PayPay決済番号
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
Status=AUTH&ProcessDate=20191216090000&JobCd=AUTH&AccessID=67ed6da3551771c9f592cd6f7a19a90c&AccessPass=0695cc5eb676f9e11ab6e432f3747941&Amount=10000&Tax=1000&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=45&PayPayCancelAmount=500&PayPayCancelTax=50&PayPayTrackingID=12345678901234&PayPayAcceptCode=&PayPayOrderID=03694684018076303999
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001